Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/DynamicListWidget/Visibility

Visibility

enum Visibility : Enum<DynamicListWidget.Visibility> , DynamicListWidget.VisibilityProvider

Enum defining how the user sees and can interact with an entry.

Author

fzzyhmstrs

Since

0.6.0

Parameters

visible

Whether the entry is visible. A non-visible entry will take up 0 width in the list (effectively removed from the list, visually)

skip

Whether the entry should be skipped when searching

selectable

Whether the user can interact with the entry

group

Whether the entry belongs to a group

repeatable

Whether this visibility can be applied to an entry more than once

affectedBy

Predicate to determine if this visibility is affected by another

Entries

VISIBLE

Standard visibility. The Entry can be seen, searched, and interacted with.

HIDDEN

Entry hidden by a user action like toggling a group, or some visibility button. Not visible nor selectable, but searchable (in case the user reverses the hidden state after searching)

FILTERED

Entry filtered by searching. Not visible nor selectable

GROUP_VISIBLE

Visible entry that represents a group heading

GROUP_FILTERED

Filtered entry that represents a group heading

GROUP_HIDDEN

Hidden entry that represents a group heading

GROUP_DISABLED

A disabled group heading, typically caused by a layout error

HEADER_VISIBLE

A header entry. Always visible, skipped in searching, and not selectable. Visibility of headers can't be changed.

Types

Companion

object Companion

Properties

affectedBy

val affectedBy: Predicate<DynamicListWidget.Visibility>

entries

val entries: EnumEntries<DynamicListWidget.Visibility>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val group: Boolean

val name: String

val ordinal: Int

val repeatable: Boolean

selectable

val selectable: Boolean

skip

val skip: Boolean

visible

val visible: Boolean

Functions

get

open override fun get(): DynamicListWidget.Visibility

Returns the entries current Visibility status

valueOf

fun valueOf(value: String): DynamicListWidget.Visibility

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<DynamicListWidget.Visibility>

Returns an array containing the constants of this enum type, in the order they're declared.